<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="IFocusManager,mx.managers.IFocusManager,defaultButton,defaultButtonEnabled,focusPane,nextTabIndex,showFocusIndicator,activate,deactivate,findFocusManagerComponent,getFocus,getNextFocusManagerComponent,hideFocus,setFocus,showFocus" name="keywords">
<title>mx.managers.IFocusManager</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'IFocusManager - Zentrum virtUOS: virtPresenter';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">virtPresenter AsDoc</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?mx/managers/IFocusManager.html&amp;mx/managers/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Interface&nbsp;IFocusManager</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Interface IFocusManager"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">mx.managers</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IFocusManager</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Subinterfaces</td><td><a href="../managers/IFocusManagerComplexComponent.html">IFocusManagerComplexComponent</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Implementors</td><td><a href="../containers/Accordion.html">Accordion</a>, <a href="../controls/Button.html">Button</a>, <a href="../core/Container.html">Container</a>, <a href="../managers/FocusManager.html">FocusManager</a>, <a href="../controls/listClasses/ListBase.html">ListBase</a>, <a href="../controls/RadioButton.html">RadioButton</a>, <a href="../controls/TextInput.html">TextInput</a></td>
</tr>
</table>
<p></p>
  The IFocusManager interface defines the interface that components must implement 
  to manage the focus on components in response to mouse activity or 
  keyboard activity (Tab key), and to support a default button.
   <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="../managers/FocusManager.html" target="">mx.managers.FocusManager</a>
</div>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#defaultButton">defaultButton</a> : <a href="../core/IButton.html">IButton</a>
<div class="summaryTableDescription">
      A reference to the original default Button control.</div>
</td><td class="summaryTableOwnerCol">IFocusManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#defaultButtonEnabled">defaultButtonEnabled</a> : Boolean<div class="summaryTableDescription">
      A flag that indicates whether the FocusManager should
      check for the Enter key being pressed to activate the default button.</div>
</td><td class="summaryTableOwnerCol">IFocusManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#focusPane">focusPane</a> : Sprite<div class="summaryTableDescription">
      A single Sprite that is moved from container to container
      as the focus moves to those containers.</div>
</td><td class="summaryTableOwnerCol">IFocusManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#nextTabIndex">nextTabIndex</a> : int<div class="summaryTableDescription">[read-only]
      The next unique tab index to use in this tab loop.</div>
</td><td class="summaryTableOwnerCol">IFocusManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#showFocusIndicator">showFocusIndicator</a> : Boolean<div class="summaryTableDescription">
      A flag that indicates whether to display an indicator that
      a component has focus.</div>
</td><td class="summaryTableOwnerCol">IFocusManager</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#activate()">activate</a>():void</div>
<div class="summaryTableDescription">
      The SystemManager activates and deactivates a FocusManager
      if more than one IFocusManagerContainer is visible at the same time.</div>
</td><td class="summaryTableOwnerCol">IFocusManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#deactivate()">deactivate</a>():void</div>
<div class="summaryTableDescription">
      The SystemManager activates and deactivates a FocusManager
      if more than one IFocusManagerContainer is visible at the same time.</div>
</td><td class="summaryTableOwnerCol">IFocusManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#findFocusManagerComponent()">findFocusManagerComponent</a>(o:InteractiveObject):<a href="../managers/IFocusManagerComponent.html">IFocusManagerComponent</a>
</div>
<div class="summaryTableDescription">
      Returns the IFocusManagerComponent that contains the given object, if any.</div>
</td><td class="summaryTableOwnerCol">IFocusManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getFocus()">getFocus</a>():<a href="../managers/IFocusManagerComponent.html">IFocusManagerComponent</a>
</div>
<div class="summaryTableDescription">
      Gets the IFocusManagerComponent component that currently has the focus.</div>
</td><td class="summaryTableOwnerCol">IFocusManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getNextFocusManagerComponent()">getNextFocusManagerComponent</a>(backward:Boolean = false):<a href="../managers/IFocusManagerComponent.html">IFocusManagerComponent</a>
</div>
<div class="summaryTableDescription">
      Returns the IFocusManagerComponent that would receive focus
      if the user pressed the Tab key to navigate to another component.</div>
</td><td class="summaryTableOwnerCol">IFocusManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#hideFocus()">hideFocus</a>():void</div>
<div class="summaryTableDescription">
      Sets <code>showFocusIndicator</code> to <code>false</code>
      and removes the visual focus indicator from the focused object, if any.</div>
</td><td class="summaryTableOwnerCol">IFocusManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setFocus()">setFocus</a>(o:<a href="IFocusManagerComponent.html">IFocusManagerComponent</a>):void</div>
<div class="summaryTableDescription">
      Sets focus to an IFocusManagerComponent component.</div>
</td><td class="summaryTableOwnerCol">IFocusManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#showFocus()">showFocus</a>():void</div>
<div class="summaryTableDescription">
      Sets <code>showFocusIndicator</code> to <code>true</code>
      and draws the visual focus indicator on the focused object, if any.</div>
</td><td class="summaryTableOwnerCol">IFocusManager</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="defaultButton"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">defaultButton</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>defaultButton:<a href="../core/IButton.html">IButton</a></code>&nbsp;&nbsp;[read-write]<p>
      A reference to the original default Button control.
      Pressing the Enter key while the focus is on any control 
      activates the Button control by dispatching a <code>click</code> event 
      on the Button control, just as if it was clicked with the mouse.
      The actual default Button control changes if focus is given to another
      Button control, but switches back to the original if focus is not
      on a button.
           </p><p>This property is managed by Flex containers; do not set it directly
      to specify the default button.</p>
     
      <p>The <code>defaultButton</code> must be of class
      <code>mx.controls.Button</code> even though this property
      is of type <code>IUIComponent</code>.</p>
     <span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get defaultButton():<a href="../core/IButton.html">IButton</a></code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set defaultButton(value:<a href="../core/IButton.html">IButton</a>):void</code>
<br>
</div>
<a name="defaultButtonEnabled"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">defaultButtonEnabled</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>defaultButtonEnabled:Boolean</code>&nbsp;&nbsp;[read-write]<p>
      A flag that indicates whether the FocusManager should
      check for the Enter key being pressed to activate the default button.
      TextArea and other components that want to recognize 
      the <code>Enter</code> key
      set this property to <code>false</code> to disable the Enter
      key from dispatching a <code>click</code> event on the
      default button, if it exists.
     </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get defaultButtonEnabled():Boolean</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set defaultButtonEnabled(value:Boolean):void</code>
<br>
</div>
<a name="focusPane"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">focusPane</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>focusPane:Sprite</code>&nbsp;&nbsp;[read-write]<p>
      A single Sprite that is moved from container to container
      as the focus moves to those containers.
      The Sprite is used as the parent of the visual indicator
      that a component has focus.
     </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get focusPane():Sprite</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set focusPane(value:Sprite):void</code>
<br>
</div>
<a name="nextTabIndex"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">nextTabIndex</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>nextTabIndex:int</code>&nbsp;&nbsp;[read-only]<p>
      The next unique tab index to use in this tab loop.
     </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get nextTabIndex():int</code>
<br>
</div>
<a name="showFocusIndicator"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">showFocusIndicator</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>showFocusIndicator:Boolean</code>&nbsp;&nbsp;[read-write]<p>
      A flag that indicates whether to display an indicator that
      a component has focus.
      If <code>true</code> a component receiving focus
      draws a visible indicator that it has focus.
           </p><p>By default, this is <code>false</code> until the user uses
      the Tab key, then it is set to <code>true</code>.</p>
           <p>In general it is better to use 
      the <code>showFocus()</code> and <code>hideFocus()</code> methods
      to change this property as those methods also update the
      visual indicator that a component has focus.</p>
     <span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get showFocusIndicator():Boolean</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set showFocusIndicator(value:Boolean):void</code>
<br>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="activate()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">activate</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function activate():void</code><p>
      The SystemManager activates and deactivates a FocusManager
      if more than one IFocusManagerContainer is visible at the same time.
      If the mouse is clicked in an IFocusManagerContainer with a deactivated
      FocusManager, the SystemManager will call 
      the <code>activate()</code> method on that FocusManager.
      The FocusManager that was activated will have its <code>deactivate()</code> method
      called prior to the activation of another FocusManager.
     </p></div>
<a name="deactivate()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">deactivate</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function deactivate():void</code><p>
      The SystemManager activates and deactivates a FocusManager
      if more than one IFocusManagerContainer is visible at the same time.
      If the mouse is clicked in an IFocusManagerContainer with a deactivated
      FocusManager, the SystemManager will call 
      the <code>activate()</code> method on that FocusManager.
      The FocusManager that was activated will have its <code>deactivate()</code> method
      called prior to the activation of another FocusManager.
     </p></div>
<a name="findFocusManagerComponent()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">findFocusManagerComponent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function findFocusManagerComponent(o:InteractiveObject):<a href="../managers/IFocusManagerComponent.html">IFocusManagerComponent</a></code><p>
      Returns the IFocusManagerComponent that contains the given object, if any.
      Because the player can set focus to a subcomponent of a Flex component
      this method determines which IFocusManagerComponent has focus from
      the component perspective.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">o</span>:InteractiveObject</code> &mdash; An object that can have player-level focus.
           </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../managers/IFocusManagerComponent.html">IFocusManagerComponent</a></code> &mdash; 
                        The IFOcusManagerComponent containing <code>o</code> or 
      <code>null</code>
     
                        
                     </td>
</tr>
</table>
</div>
<a name="getFocus()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getFocus</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getFocus():<a href="../managers/IFocusManagerComponent.html">IFocusManagerComponent</a></code><p>
      Gets the IFocusManagerComponent component that currently has the focus.
      Calling this method is recommended instead of using the Stage object 
      because it indicates which component has focus.
      The Stage might return a subcomponent in that component.
           </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../managers/IFocusManagerComponent.html">IFocusManagerComponent</a></code> &mdash; 
                        IFocusManagerComponent object that has focus.
     
                        
                     </td>
</tr>
</table>
</div>
<a name="getNextFocusManagerComponent()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getNextFocusManagerComponent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getNextFocusManagerComponent(backward:Boolean = false):<a href="../managers/IFocusManagerComponent.html">IFocusManagerComponent</a></code><p>
      Returns the IFocusManagerComponent that would receive focus
      if the user pressed the Tab key to navigate to another component.
      It will return the same component as the current focused component
      if there are no other valid components in the application.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">backward</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; If <code>true</code>, return the object 
      as if the Shift-Tab keys were pressed.
           </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../managers/IFocusManagerComponent.html">IFocusManagerComponent</a></code> &mdash; 
                        The component that would receive focus.
     
                        
                     </td>
</tr>
</table>
</div>
<a name="hideFocus()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">hideFocus</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function hideFocus():void</code><p>
      Sets <code>showFocusIndicator</code> to <code>false</code>
      and removes the visual focus indicator from the focused object, if any.
     </p></div>
<a name="setFocus()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setFocus</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setFocus(o:<a href="IFocusManagerComponent.html">IFocusManagerComponent</a>):void</code><p>
      Sets focus to an IFocusManagerComponent component.  Does not check for
      the components visibility, enabled state, or any other conditions.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">o</span>:<a href="IFocusManagerComponent.html">IFocusManagerComponent</a></code> &mdash; A component that can receive focus.
     </td>
</tr>
</table>
</div>
<a name="showFocus()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">showFocus</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function showFocus():void</code><p>
      Sets <code>showFocusIndicator</code> to <code>true</code>
      and draws the visual focus indicator on the focused object, if any.
     </p></div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
